Language:

Nearby Insights

Delivers information about the vicinity of a property, including details about schools, amenities, crime rates, and other neighborhood statistics, helping assess the desirability of a location.​

Endpoint URL

https://api.propertyreach.com/v1/nearby-insightsCopy
Request Body
target
propertyId
int
PropertyReach Property ID
streetAddress
string
What's the property street address
city
string
The city where the property is located.
state
string
State search criteria
zip
string
Property zip code
county
string
The county where the property is located.
fips
string
The Federal Information Processing Standard (FIPS) code for the property's location.
apn
string
The Assessor’s Parcel Number (APN), a unique identifier assigned to the property by the local tax authority.
filter
quickFilter
string
neighbor, cash_buyer, pre_foreclosure, bank_owned, lien, high_equity, vacant, free_clear
distanceFromSubject
decimal
Maximum search radius (in miles) to search for comps. Default 0.5 mi.
landUseCode
int
List of land use codes
lastSaleDateMin
date
Minimum Last Sale Date
lastSaleDateMax
date
Maximum Last Sale Date
bathroomsMin
decimal
Minimum Bathrooms
bathroomsMax
decimal
Maximum Bathrooms
bedroomsMin
int
Minimum Bedrooms
bedroomsMax
int
Maximum Bedrooms
squareFeetMin
int
Minimum Square Feet
squareFeetMax
int
Maximum Square Feet
lotSquareFeetMin
int
Minimum Lot Square Feet
lotSquareFeetMax
int
Maximum Lot Square Feet
yearBuiltMin
smallint
Minimum Year Built
yearBuiltMax
smallint
Maximum Year Built
saleSituation[]
array
What sale situation was involved in the property sale. Possible values: "Cash Purchase", "Financed", "New Construction", "Intra-Family", "Foreclosure", "Bank Sale"
propertyClassCode[]
array
Property Class Code. Possible values: "R" = Residential, "C" = Commercial, "V" = Vacant, "O" = Other
subdivision[]
array
Property subdivision
multiParcel
boolean
  • Any
  • Yes
  • No
Indicates whether the property is part of a multi-parcel sale or ownership.
Response Body
meta
status
decimal
required
Response status
message
string
required
Response message.
requestId
string
Unique ID for the request.
resultCount
int
Number of results found
hits
decimal
Number of credits deducted from your API usage balance for this call
properties
bathrooms
decimal
The total number of bathrooms in the property.
bedrooms
int
The total number of bedrooms in the property.
city
string
The city where the property is located.
daysOnMarket
string
The number of days the property has been listed on the market.
estimatedValue
int
The estimated market value of the property.
id
int
Id
landUse
string
Land Use
lastSaleAmount
int
Last Sale Amount
lastSaleDate
date
Last Sale Date
listingStatus
string
Listing Status
lotSquareFeet
int
The total square footage of the property’s lot.
multiParcel
boolean
Indicates whether the property is part of a multi-parcel sale or ownership.
onMarket
boolean
Indicates whether the property is currently listed for sale.
photosAvailable
boolean
Are property photos available
photoUrl
string
Photo URL
pool
boolean
Does the property have a pool
pricePerSquareFoot
decimal
What is the price per sqare foot
propertyType
string
Property Type Codes. Possible values: "Co-Op", "Commercial", "Condo", "House", "Land", "Multi-Family", "Office", "Other", "Townhouse".
saleSituation
string
What sale situation was involved in the property sale. Possible values: "Cash Purchase", "Financed", "New Construction", "Intra-Family", "Foreclosure", "Bank Sale"
squareFeet
int
Property square footage
state
string
State search criteria
stories
decimal
How many stories does the property have
streetAddress
string
What's the property street address
subdivision
string
Property subdivision
units
string
Number of apartment units
yearBuilt
smallint
What year was the property built
zip
string
Property zip code
  • Source
  • JSON
Copy
var body = {}; var options = { method: 'POST', body: JSON.stringify(body), headers: { 'x-api-key': 'test_examp****' } }; var url = 'https://api.propertyreach.com/v1/nearby-insights'; fetch(url, options) .then(response => response.json()) .then(result => console.log(result)) .catch(error => console.log('error', error));
{ }